gh-138071: Clarify curses.color_pair doc about style vs extraction masks #138079
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation fix
This PR clarifies the wording in the
curses.color_pair
documentation.Previously it said:
This was ambiguous because constants like
A_COLOR
,A_ATTRIBUTES
, andA_CHARTEXT
also follow theA_*
pattern, but those are extraction masks and cannot be combined withcurses.color_pair()
.Changes made
Doc/library/curses.rst
:curses.color_pair(n)
is an attribute mask that can be combined (using|
) with style attributes likeA_BOLD
,A_REVERSE
,A_UNDERLINE
.A_COLOR
,A_ATTRIBUTES
, andA_CHARTEXT
are extraction masks used with&
on values returned fromwindow.inch()
, and must not be combined withcolor_pair()
.Why this is needed
A_*
constants can be OR'ed withcurses.color_pair
.Example